Skip to content

fix moniker selector on overview pages #2196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 3 commits into from
Closed

fix moniker selector on overview pages #2196

wants to merge 3 commits into from

Conversation

herohua
Copy link
Collaborator

@herohua herohua commented Jun 27, 2022 •
edited
Loading

This PR is to fix missing moniker selector for overview pages auto generated by build pipeline (api/overview/azure/**/*.yml) or written in markdown format (api/overview/azure/**/*.md).

Example: There is no moniker selector on https://docs.microsoft.com/en-us/dotnet/api/overview/azure/activedirectory?view=azure-dotnet that is authored in markdown format at https://github.com/Azure/azure-docs-sdk-dotnet/blob/live/api/overview/azure/activedirectory.md

With this PR, moniker selector will be available on overview pages (no matter whether they are generated in build pipeline or hand-written by content team in markdown files):

@herohua herohua changed the title fix moniker issues with hand-written service pages [WIP] fix moniker issues with hand-written service pages Jun 27, 2022
@herohua herohua changed the title [WIP] fix moniker issues with hand-written service pages fix moniker selector on overview pages Jun 27, 2022
@danieljurek
Copy link
Collaborator

This publishes all overview docs to all monikers which does not get us the differentiated overview documents that we need in each moniker.

For example, on this Key Vault overview page in the Latest moniker I see the expected page:
image

When I switch to the Preview moniker I see the same page:
image

The page that I should see is the one with the title Azure Key Vault key client library for .NET - Version 4.3.0-beta.7 (source link)

I think we can accomplish this by moving the -pre.md files out of the overview folder into another preview moniker specific folder and removing the -pre from the filename. I attempted to do that in this branch but the results did not include the ToC and the moniker selector also did not work:
image

"Showing the moniker selector on overview" to us means that moniker selection behavior works as it does in our other languages.

@herohua
Copy link
Collaborator Author

herohua commented Jun 29, 2022

@danieljurek We need another fix on docs.json along with folder structure and TOC.yml change to make your desired experience happen. I will try to produce another PR to demonstrate to you (which will be based on this PR).

@herohua herohua mentioned this pull request Jun 29, 2022
Open
@herohua
Copy link
Collaborator Author

herohua commented Jun 30, 2022 •
edited
Loading

Close this PR as it will be superseded by #2199

@herohua herohua closed this Jun 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@herohua @danieljurek